Контрагент (клиент)

Параметры запроса

Передаваемые параметры отсутствуют.

Пример запроса

https://api.gigma.ru/api/counterparty

Ответ

При успешном действии возвращается HTTP код 200.

{
    "counterparty": {
        "id": 1,
        "type": {
            "id": 2,
            "name": "Розница",
            "created_at": "2024-03-23T10:27:06.000000Z"
        },
        "manager": {
            "id": 1,
            "first_name": "Артём",
            "last_name": "Полищук",
            "middle_name": "Николаевич",
            "name": "Полищук Артём"
        },
        "avatar": null,
        "first_name": "Алексей",
        "last_name": "Петров",
        "middle_name": "Викторович",
        "birthday": "1980-04-02",
        "address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20/1, кв. 26",
        "phone_1": "79999999990",
        "phone_2": "78888888888",
        "email": "support@itecho.ru",
        "created_at": "2024-03-22T14:01:37.000000Z",
        "updated_at": "2024-03-23T10:48:33.000000Z"
    }
}

Описание полей ответа

• id — первичный ключ
• type — объект с информацией о типе контрагента
  • id — идентификатор типа
  • name — название типа
  • created_at — дата создания
• manager — объект с информацией о менеджере
  • id — идентификатор менеджера
  • first_name — имя менеджера
  • last_name — фамилия менеджера
  • middle_name — отчество менеджера
  • name — полное имя менеджера
• avatar — объект с информацией об аватаре пользователя
• first_name — имя контрагента
• last_name — фамилия контрагента
• middle_name — отчество контрагента
• birthday — дата рождения
• address — адрес
• phone_1 — основной номер телефона
• phone_2 — дополнительный номер телефона
• email — электронная почта
• created_at — дата создания
• updated_at — дата последнего обновления

Параметры запроса

• avatar_id — ID аватара, загруженного при помощи запроса (может быть пустым, нулевым или NULL)
• first_name — имя (может быть пустым, нулевым или NULL)
• last_name — фамилия (может быть пустым, нулевым или NULL)
• email — email (может быть пустым, нулевым или NULL)
• address — адрес клиента из Dadata (может быть пустым, нулевым или NULL)

Примечание: поле phone является константным.

Пример запроса

{
    "avatar_id": 17,
    "first_name": "Алексей",
    "last_name": "Петров",
    "email": "test@mail.ru"
}

Ответ

При успешном действии возвращается HTTP код 200.

{
    "counterparty": {
        "id": 14,
        "type": {
            "id": 1,
            "name": "Заказчик",
            "created_at": "2024-03-27T07:00:46.000000Z"
        },
        "manager": {
            "id": 1,
            "first_name": "Артём",
            "last_name": "Полищук",
            "middle_name": "Николаевич",
            "name": "Полищук Артём"
        },
        "avatar": {
            "id": 17,
            "name": "Чек.png",
            "type": {
                "id": 2,
                "name": "Аватар",
                "created_at": "2024-03-27T07:00:46.000000Z"
            },
            "path": "https://beta.back.erp.itecho.ru/storage/uploads/dGOPVMjBgjlb3CQjaU7G0HK6Z4q1aATVzfgbGGhM.png",
            "created_at": "2024-05-14T11:44:21.000000Z",
            "updated_at": "2024-05-14T11:44:21.000000Z"
        },
        "first_name": "Алексей",
        "last_name": "Петров",
        "middle_name": null,
        "birthday": null,
        "address": null,
        "phone_1": "79498102351",
        "phone_2": null,
        "email": "test@mail.ru",
        "created_at": "2024-04-01T08:01:53.000000Z",
        "updated_at": "2024-05-14T11:44:39.000000Z"
    }
}

Параметры запроса

Передаваемые параметры отсутствуют.

Пример запроса

https://api.gigma.ru/api/counterparty

Ответ

При успешном действии возвращается HTTP код 200.

{
    "message": "Counterparty successfully deleted"
}

Описание полей ответа

• message — информационное сообщение

Инициирует звонок-сброс на новый номер телефона для подтверждения смены.

Параметры запроса

• phone (string, обязательно) — новый номер телефона

Ответ

При успешном действии возвращается HTTP код 200 с подтверждением отправки звонка.

Подтверждает смену номера телефона после получения кода из звонка-сброса.

Параметры запроса

• phone (string, обязательно) — новый номер телефона
• password (string, обязательно) — последние 4 цифры номера позвонившего (код подтверждения)

Ответ

При успешном действии возвращается HTTP код 200 с обновлёнными данными контрагента.